Pular para o conteúdo principal

15.2 Quebrar acordo

Request

Request
mutation BreakAgreement {
breakAgreement(data: {
agreementId: 44,
breachReason: NON_PAYMENT,
breachDescription: "Quebra de acordo teste"
}) {
status
financialOwnerId
companyId
breachDate
breachReason
breachDescription
description
requester
agreementDate
parcelQuantity
originalValue
negotiatedValue
amountPaid
id
refId
externalId
creationDate
active
deleted
lastUpdateDate
}
}

Params

ParâmetroTipoDescrição
dataBreakAgreementDataInput!Dados de quebra do acordo

Objeto BreakAgreementDataInput

ParâmetroTipoObrigatórioDescrição
agreementIdInt!SimId do acordo a ser quebrado
breachDescriptionStringNãoDescrição do motivo da quebra
breachReasonAgreementBreachReason!SimMotivo da quebra do acordo

Response

Response
{
"data": {
"breakAgreement": {
"status": "BROKEN",
"financialOwnerId": 4471,
"companyId": 23,
"breachDate": "2026-01-29T17:14:31.393Z",
"breachReason": "NON_PAYMENT",
"breachDescription": "Quebra de acordo teste",
"description": null,
"requester": "REVO",
"agreementDate": "2026-01-23T00:00:00.000Z",
"parcelQuantity": null,
"originalValue": 360,
"negotiatedValue": 800,
"amountPaid": null,
"id": 44,
"refId": "9ec59fc8-485e-4232-ac52-7eb09ad70490",
"externalId": null,
"creationDate": "2026-01-29T17:13:35.720Z",
"active": true,
"deleted": false,
"lastUpdateDate": null
}
}
}

Result

CampoTipoDescrição
breakAgreementAgreementDados do acordo

Objeto Agreement

CampoTipoDescrição
statusAgreementStatusStatus do acordo
financialOwnerIdIntId do responsável financeiro
financialOwnerFinancialOwnerDados do responsável financeiro
companyIdIntId da Empresa
companyCompanyDados da Empresa
breachDateDateTimeData de quebra do acordo
breachReasonAgreementBreachReasonMotivo da quebra do acordo
breachDescriptionStringDescrição do motivo da quebra
descriptionStringObservações do acordo
billingAgreements[BillingAgreement!]!Cobranças associadas ao acordo
requesterAgreementRequesterIdentificador de quem está solicitando o acordo
bankBankConta de recebimento
agreementDateDateTimeData do acordo
parcelQuantityIntQuantidade de parcelas do acordo
idIntId do objeto da Requisição
refIdUUIDId da Referência
externalIdIntId Externo
creationDateDateTimeData de Criação
activeBooleanStatus de Ativação
deletedBooleanStatus de Deleção
changes[LogHistory!]!Histórico de alterações
lastUpdateDateDateTimeData da ultima atualização

Objeto BillingAgreement

CampoTipoDescrição
idIntIdentificador único do registro
creationDateDateTimeData de criação do registro
billingIdIntId da Cobrança
billingBillingDados da Cobrança
interestDecimalJuros
appliedFineDecimalMulta
appliedDiscountDecimalValor de desconto concedido
paymentDateDateTimeData da baixa
bankPaymentDateDateTimeData do pagamento (banco para Kedu)
isOriginalAgreementBillingBooleanIndica se o boleto é um boleto original no acordo
discountTargetAgreementDiscountTargetEm que o desconto foi apli